Use eep48 "group" to group functions in OTP documentation and shell completion #9408
Conversation
CT Test Results 19 files 788 suites 5h 59m 15s ⏱️ For more details on these failures, see this check. Results for commit e9c0b1c. ♻️ This comment has been updated with latest results. To speed up review, make sure that you have read Contributing to Erlang/OTP and that all checks pass. See the TESTING and DEVELOPMENT HowTo guides for details about how to run test locally. Artifacts// Erlang/OTP Github Action Bot |
make/ex_doc.exs
Outdated
| @@ -72,47 +72,47 @@ modules = | |||
|
|
|||
| titles = | |||
| modules | |||
| |> Enum.reduce( | |||
| |> Enum.reduce( | |||
There was a problem hiding this comment.
Do we still need this? I was hoping ExDoc would do this for us now.
There was a problem hiding this comment.
Yes, ExDocs default sorting is:
+groups_for_docs # if there is a match in this list, put it in this group
# if there is no match in the groups for docs list, and metadata[:group] does not exist
# put in the default groups below
+Types,
+Callbacks
+Functions
# If there are groups explicit in the module put them here
# (in the order they appeared and dont distinguish on :kind)
+ BGroup
+ CGroup
+ AGroup
groups_for_docs = [Wrap: fn a -> a[:kind] == :function && String.match(a[:group], r/falafel/) end]
Would give us:
+Wrap
+Types
+Callbacks
+Functions
+BGroup
+CGroup
+AGroup
In contrast this is how it worked before in OTP using :titles and :title:
(In the order they appear in :titles)
+Types: Bs
+Types: As
+Types:
+Callbacks: Bs
+Callbacks: As
+Callbacks:
+Bs:
+Aa:
+Functions:
In this update this has changed to alphabetical-ish (because of removal of :titles):
+Types: As
+Types: Bs
+Types:
+Callbacks: As
+Callbacks: Bs
+Callbacks:
+As:
+Bs:
+Functions:
frazze-jobb
force-pushed
the
frazze/stdlib/support_eep48_group_metadata/OTP-19483
branch
from
b75aeec to
8c187a8
Compare
frazze-jobb
added
testing
Fix formatting
frazze-jobb
force-pushed
the
frazze/stdlib/support_eep48_group_metadata/OTP-19483
branch
from
e4a0bb9 to
e9c0b1c
Compare
frazze-jobb
added
the
testing
No description provided.